MarkLogic 9 Product Documentation

GET /manage/v2/forests/{id|name}?view=counts

Summary

Retrieve count information about a forest. The forest can be identified either by id or name.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data.

Required Privileges

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The counts view includes the stand count, document count, directory count, reindex refragment fragment count, reindex fragment count, and refragment document count.

The structure of the output returned from this REST API is as follows:

id

A forest unique ID (64-bit value).

name

The forest name.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

count-properties

The statistics about the forest.

This is a complex structure with the following children:

error

The error in processing forest status.

rebalancer-error

The error in rebalancing.

stands-counts

The counts of stands.

This is a complex structure with the following children:

stand-counts

The stand's counts.

This is a complex structure with the following children:

stand-id

The unique key of a stand.

path

The path of the stand.

active-fragment-count

The number of fragments.

nascent-fragment-count

The number of nascent fragments.

deleted-fragment-count

The number of deleted fragments.

document-count

The number of documents in the forest.

directory-count

The number of directories in the forest.

all-query-rolesets-fragment-count

The number of fragments indexed with each query-rolesets.

This is a complex structure with the following children:

query-rolesets-fragment-count

The number of fragments indexed with this query-rolesets.

This is a complex structure with the following children:

query-rolesets-id

The unique key of a query-rolesets.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-refragment-fragment-count

The number of fragments that need to be reindexed or refragmented.

reindex-refragment-rate

The rate of reindexing/refragmenting.

forced-reindex-fragment-count

The number of fragments that need to be reindexed due for forced reindexing.

reindex-fragment-count

The number of fragments that need to be reindexed.

reindex-previous-versions-count

The number of fragments that need previous versions (used with point-in-time queries) reindexed.

reindex-stemmed-searches-count

The number of fragments that need basic stemmed search reindexed.

reindex-word-searches-count

The number of fragments that need word searches reindexed.

reindex-one-character-searches-count

The number of fragments that need one-character searches reindexed.

reindex-two-character-searches-count

The number of fragments that need two-character searches reindexed.

reindex-three-character-searches-count

The number of fragments that need three-character searches reindexed.

reindex-fast-phrase-searches-count

The number of fragments that need fast phrase searches reindexed.

reindex-fast-case-sensitive-searches-count

The number of fragments that need fast case-sensitive searches reindexed.

reindex-fast-element-word-searches-count

The number of fragments that need element word searches reindexed.

reindex-fast-element-phrase-searches-count

The number of fragments that need element phrase searches reindexed.

reindex-fast-element-character-searches-count

The number of fragments that need element character searches reindexed.

reindex-fast-element-trailing-wildcard-searches-count

The number of fragments that need element trailing wildcard searches reindexed.

reindex-word-positions-count

The number of fragments that need word positions reindexed.

reindex-scaled-log-tf-normalization-count

The number of fragments that scaled log-tf normalization reindexed.

reindex-unscaled-log-tf-normalization-count

The number of fragments that unscaled log-tf normalization reindexed.

reindex-element-word-positions-count

The number of fragments that need element word positions reindexed.

reindex-element-value-positions-count

The number of fragments that need element value positions reindexed.

reindex-attribute-value-positions-count

The number of fragments that need attribute value positions reindexed.

reindex-field-value-searches-count

The number of fragments that need field value searches reindexed.

reindex-field-value-positions-count

The number of fragments that need field value positions reindexed.

reindex-three-character-word-positions-count

The number of fragments that need three character word positions reindexed.

reindex-triple-index-count

The number of fragments that need triples reindexed.

reindex-triple-positions-count

The number of fragments that need triple positions reindexed.

reindex-trailing-wildcard-searches-count

The number of fragments that need trailing wildcard searches reindexed.

reindex-trailing-wildcard-word-positions-count

The number of fragments that need trailing wildcard word positions reindexed.

reindex-fast-diacritic-sensitive-searches-count

The number of fragments that need fast diacritic-sensitive searches reindexed.

reindex-word-lexicon-count

The number of fragments that need the word lexicon reindexed.

reindex-binary-threshold-count

The number of binary fragments that need to be reindexed for size threshold.

reindex-deleted-stemmed-searches-count

The number of fragments that need the stemmed search indexes deleted.

reindex-deleted-word-searches-count

The number of fragments that need the word search indexes deleted.

reindex-deleted-one-character-searches-count

The number of fragments that need the one-character search indexes deleted.

reindex-deleted-two-character-searches-count

The number of fragments that need the two-character search indexes deleted.

reindex-deleted-three-character-searches-count

The number of fragments that need the three-character search indexes deleted.

reindex-deleted-fast-phrase-searches-count

The number of fragments that need the fast phrase search indexes deleted.

reindex-deleted-fast-case-sensitive-searches-count

The number of fragments that need the fast case-sensitive search indexes deleted.

reindex-deleted-fast-element-word-searches-count

The number of fragments that need the element word search indexes deleted.

reindex-deleted-fast-element-phrase-searches-count

The number of fragments that need the element phrase search indexes deleted.

reindex-deleted-fast-element-character-searches-count

The number of fragments that need the element character search indexes deleted.

reindex-deleted-fast-element-trailing-wildcard-searches-count

The number of fragments that need the element trailing wildcard search indexes deleted.

reindex-deleted-word-positions-count

The number of fragments that need the word position indexes deleted.

reindex-deleted-element-word-positions-count

The number of fragments that need the element word position indexes deleted.

reindex-deleted-element-value-positions-count

The number of fragments that need the element value position indexes deleted.

reindex-deleted-field-value-searches-count

The number of fragments that need the field value search indexes deleted.

reindex-deleted-field-value-positions-count

The number of fragments that need the field value position indexes deleted.

reindex-deleted-attribute-value-positions-count

The number of fragments that need the attribute value position indexes deleted.

reindex-deleted-three-character-word-positions-count

The number of fragments that need the three-character word position indexes deleted.

reindex-deleted-triple-index-count

The number of fragments that need deleted triples reindexed.

reindex-deleted-triple-positions-count

The number of fragments that need deleted triple positions reindexed.

reindex-deleted-trailing-wildcard-searches-count

The number of fragments that need the trailing wildcard search indexes deleted.

reindex-deleted-trailing-wildcard-word-positions-count

The number of fragments that need the trailing wildcard word position indexes deleted.

reindex-deleted-fast-diacritic-sensitive-searches-count

The number of fragments that need the diacritic-sensitive search indexes deleted.

reindex-uri-lexicon-count

The number of fragments that need the URI lexicon reindexed.

reindex-deleted-uri-lexicon-count

The number of fragments that need the URI lexicons deleted.

reindex-collection-lexicon-count

The number of fragments that need the collection lexicon reindexed.

reindex-deleted-collection-lexicon-count

The number of fragments that need the collection lexicons deleted.

reindex-element-word-query-throughs

The reindexing of word query throughs.

This is a complex structure with the following children:

reindex-element-word-query-through

The reindexing of an element word query through.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-phrase-throughs

The reindexing of phrase throughs.

This is a complex structure with the following children:

reindex-phrase-through

The reindexing of a phrase through.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-phrase-arounds

The reindexing of phrase arounds.

This is a complex structure with the following children:

reindex-phrase-around

The reindexing of a phrase around.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-range-element-indexes

The reindexing of range element-indexes.

This is a complex structure with the following children:

reindex-range-element-index

The reindexing of a range element index.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

scalar-type

The scalar type of a range index.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-range-field-indexes

The reindexing of range field-indexes.

This is a complex structure with the following children:

reindex-range-field-index

The reindexing of a range field index.

This is a complex structure with the following children:

field-name

The field name.

scalar-type

The scalar type of a range index.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-range-path-indexes

The reindexing of range path-indexes.

This is a complex structure with the following children:

reindex-range-path-index

The reindexing of a range path index.

This is a complex structure with the following children:

path-expression

The path expression.

scalar-type

The scalar type of a range index.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-range-element-attribute-indexes

The reindexing of range element attribute indexes.

This is a complex structure with the following children:

reindex-range-element-attribute-index

The reindexing of a range element attribute index.

This is a complex structure with the following children:

parent-namespace-uri

A namespace URI.

parent-localname

One or more localnames.

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-deleted-range-indexes

The reindexing of removed range indexes.

This is a complex structure with the following children:

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-element-word-lexicons

The reindexing of element word lexicons.

This is a complex structure with the following children:

reindex-element-word-lexicon

The reindexing of an element word lexicon.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-element-attribute-word-lexicons

The reindexing of element attribute word lexicons.

This is a complex structure with the following children:

reindex-element-attribute-word-lexicon

The reindexing of an element attribute word lexicon.

This is a complex structure with the following children:

parent-namespace-uri

A namespace URI.

parent-localname

One or more localnames.

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-all-deleted-word-lexicons

The reindexing of removed word lexicons.

This is a complex structure with the following children:

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-geospatial-element-indexes

The reindexing of geospatial element indexes.

This is a complex structure with the following children:

reindex-geospatial-element-index

The reindexing of a geospatial element index.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-geospatial-element-child-indexes

The reindexing of geospatial element child indexes.

This is a complex structure with the following children:

reindex-geospatial-element-child-index

The reindexing of a geospatial element child index.

This is a complex structure with the following children:

parent-namespace-uri

A namespace URI.

parent-localname

One or more localnames.

namespace-uri

A namespace URI.

localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-geospatial-element-pair-indexes

The reindexing of geospatial element pair indexes.

This is a complex structure with the following children:

reindex-geospatial-element-pair-index

The reindexing of a geospatial element pair index.

This is a complex structure with the following children:

parent-namespace-uri

A namespace URI.

parent-localname

One or more localnames.

latitude-namespace-uri

A namespace URI.

latitude-localname

One or more localnames.

longitude-namespace-uri

A namespace URI.

longitude-localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-geospatial-element-attribute-pair-indexes

The reindexing of geospatial element indexes.

This is a complex structure with the following children:

reindex-geospatial-element-attribute-pair-index

The reindexing of a geospatial element attribute pair index.

This is a complex structure with the following children:

parent-namespace-uri

A namespace URI.

parent-localname

One or more localnames.

latitude-namespace-uri

A namespace URI.

latitude-localname

One or more localnames.

longitude-namespace-uri

A namespace URI.

longitude-localname

One or more localnames.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-geospatial-region-indexes

The reindexing of geospatial region indexes.

This is a complex structure with the following children:

reindex-geospatial-region-index

The reindexing of a geospatial region index.

This is a complex structure with the following children:

path-expression

The path expression.

coordinate-system

A coordinate system name.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-deleted-geospatial-region-indexes

The reindexing of removed geospatial region indexes.

This is a complex structure with the following children:

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-protected-paths

The reindexing of protected paths.

This is a complex structure with the following children:

reindex-protected-path

The reindexing of a protected path.

This is a complex structure with the following children:

path-expression

The path expression.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-deleted-protected-paths

The reindexing of removed protected paths.

This is a complex structure with the following children:

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-tde-templates

The reindexing of TDE templates.

This is a complex structure with the following children:

reindex-tde-template

A reindexing of a TDE template.

This is a complex structure with the following children:

tde-template

A template.

reindex-fragment-count

The number of fragments that need to be reindexed.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

reindex-deleted-tde-templates

A reindexing of deleted TDE templates.

This is a complex structure with the following children:

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

refragment-document-count

The number of documents that need to be refragmented.

refragment-fragment-roots

The refragmenting of fragment roots.

This is a complex structure with the following children:

refragment-fragment-parent

The refragmenting of fragment parent.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

refragment-document-count

The number of documents that need to be refragmented.

document-count

The number of documents in the forest.

refragment-fragment-parents

The refragmenting of fragment parents.

This is a complex structure with the following children:

refragment-fragment-parent

The refragmenting of fragment parent.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

localname

One or more localnames.

refragment-document-count

The number of documents that need to be refragmented.

document-count

The number of documents in the forest.

refragment-new-fields

The refragmenting of new fields.

This is a complex structure with the following children:

refragment-new-field

The refragmenting of a new field.

This is a complex structure with the following children:

field-name

The field name.

refragment-document-count

The number of documents that need to be refragmented.

document-count

The number of documents in the forest.

refragment-modified-fields

The refragmenting of modifiedfields.

This is a complex structure with the following children:

refragment-modified-field

The refragmenting of a new field.

This is a complex structure with the following children:

field-name

The field name.

refragment-document-count

The number of documents that need to be refragmented.

document-count

The number of documents in the forest.

refragment-removed-configurations

Refragmenting old fragment root/parent settings

This is a complex structure with the following children:

refragment-document-count

The number of documents that need to be refragmented.

reindex-reverse-searches-fragment-count

The number of fragments that need to be reindexed for reverse searches.

rebalance-fragment-counts

The number of fragments that need to be rebalanced out.

This is a complex structure with the following children:

rebalance-fragment-count

A destination and the number of fragments that need to be rebalanced to this destination.

This is a complex structure with the following children:

rebalance-destination

The destination of the rebalancing operation.

fragment-count

The total number of fragments for a given reindexing or rebalancing activity.

rebalance-rate

The rate of rebalancing.

active-fragment-count

The number of fragments.

deleted-fragment-count

The number of deleted fragments.

nascent-fragment-count

The number of nascent fragments.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

http://localhost:8002/manage/v2/forests/my-forest?view=counts&property=document-count

==> Returns count information for the document-count property of my-forest.